home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / util2 / runwn21s.zip / RUNWEN.DOC < prev    next >
Text File  |  1992-10-25  |  11KB  |  228 lines
  1.      **********************************************************************
  2.      *                                                                    *
  3.      *                       RunWen Users Manual                          *
  4.      *                                                                    *
  5.      *              RunWen - A Boot-up Program Scheduler                  *
  6.      *                                                                    *
  7.      *               Copyright (c) 1992 Richard Hiester                   *
  8.      *                       All Rights Reserved                          *
  9.      *                                                                    *
  10.      *                          CIS 70562,436                             *
  11.      *                                                                    *
  12.      **********************************************************************
  13.  
  14.      INTRODUCTION
  15.      ============
  16.  
  17.      RunWen is a DOS Program Scheduler which is normally started from your 
  18.      AUTOEXEC.BAT file.  This means that the programs you specify will be
  19.      started by RunWen when you boot-up your computer.  RunWen can age
  20.      the specified programs to run everytime you boot your computer, once 
  21.      a day, or once every N days.  Options are available to specify how
  22.      you want RunWen to run (in prompt or noprompt mode), to list the 
  23.      RunWen source file (RUNWEN.FIL), to display the RunWen Version number,
  24. |    to display a two-page help screen, and to edit the RUNWEN.FIL using
  25. |    your favorite editor.  
  26.  
  27. |    New features are specified in this document by a "|" in column one
  28. |    on the line which describes the new feature (see above).
  29.  
  30.      RunWen will start all executable file types (.EXE's, .COM's , .BAT's
  31. |    & 4DOSs .BTM's) but be aware of the difference in the way RunWen starts
  32.      .EXE & .COM files as compared to .BAT & .BTM files.  The .EXE & .COM
  33.      files are "spawned" whereas .BAT & .BTM files are executed via a "system"
  34.      call.  The "spawned" process will inherit RunWen's current environment
  35.      whereas the "system" executed process uses the default system environment.
  36.      What this means is that for .BAT & .BTM files, additional memory is used
  37.      in order to envoke the secondary environment.
  38.  
  39.      With the use of the RUNWEN environment variable, RunWen is an excellent
  40.      program for use by LAN Administrators.  The RunWen program will read
  41.      the RUNWEN.FIL which resides in the subdirectory specified in the 
  42.      RUNWEN environment variable. By placing the command "RUNWEN -BOOT -NOP" 
  43.      in the autoexec.bat file of each node on the network, the LAN
  44.      Administrator can ensure that the appropriate programs (i.e.
  45.      AnviVirus, Disk Scan, etc.) are run on each node on a scheduled basis.  
  46.      The RUNWEN environment variable can be set to the location of the 
  47.      RUNWEN.FIL source file, which can be placed on a read-only file system 
  48.      so it can not be altered by the user community.  If individual nodes
  49.      on the LAN have different boot-up requirements a copy of the RUNWEN.FIL
  50.      can be placed on the local node and customized according to that nodes
  51.      requirements.  The RUNWEN environment variable can then be pointed
  52.      to the RUNWEN.FIL on the local node and RunWen will process the local
  53.      RUNWEN.FIL upon boot-up.
  54.  
  55.                                                                    Page 2
  56.      INSTALLATION
  57.      ============
  58.  
  59.      The following files are part of this release of RunWen:
  60.  
  61.           RUNWEN.EXE   - The RunWen executable.
  62.           RUNWEN.FIL   - The RunWen source file.
  63.           RUNWEN.DOC   - This documentation file.
  64.           ORDERFRM.DOC - The order form used to register RunWen.
  65.           HISTORY.DOC  - A version history of RunWen.
  66.  
  67.      The installation of RunWen is easy:
  68.  
  69.      1)  Copy the above files into your desired directory.
  70.  
  71.      2)  Edit the RUNWEN.FIL source file to specify which DOS programs 
  72.          you want aged.
  73.  
  74.      3)  Edit your AUTOEXEC.BAT file adding the following lines:
  75.  
  76.               set RUNWEN=DRIVE:\DIRECTORY_TO_RUNWEN.FIL
  77. |             set EDITOR=YOUR_FAVORITE_EDITOR.EXTENSION
  78.  
  79.               [DRIVE:PATH]RUNWEN -BOOT [-NOPROMPT]
  80.  
  81.      4)  Reboot your computer to start using RunWen.
  82.  
  83.  
  84.      CONFIGURATION
  85.      =============
  86.  
  87.      The only configuration necessary for using RunWen is to add your
  88.      desired programs to the RUNWEN.FIL source file.  The RUNWEN.FIL
  89.      file contains one line for each program you want aged.  For you
  90.      UNIX types, the RUNWEN.FIL format is simular to the crontab.  The
  91.      RUNWEN.FIL format is as follows:
  92.  
  93.      YYYYMMDD DYS DOS_COMMAND_LINE
  94.  
  95.      where YYYYMMDD is the four-digit year, two-digit month, and two
  96.      digit day that you want RunWen to start aging the program from,
  97.      DYS is the number of days you want between executions of the program,
  98.      and DOS_COMMAND_LINE is the DOS command line you would enter to start
  99.      the program.  For instance, one of the programs I use RunWen for
  100.      is to run the Norton AntiVirus program.  I have the following entry in
  101.      my RUNWEN.FIL to run the Norton AntiVirus (full scan, all disks)
  102.      every seven days:
  103.  
  104.      19920801 7 C:\NDW\NAV.EXE /A
  105.  
  106.      By placing the above line in the RUNWEN.FIL file, Norton AntiVirus 
  107.      will be run the first time you boot your computer on (or after) 
  108.      August 8, 1992.  When the program is run, the RUNWEN.FIL is updated
  109.      to the NEW last date the program was run.  That is, if the AntiVirus
  110.      program is run on August 8, 1992, the the new entry in the RUNWEN.FIL
  111.      file will be:
  112.  
  113.      19920808 7 C:\NDW\NAV.EXE /A
  114.  
  115.                                                                    Page 3
  116.  
  117.      and the AntiVirus program will not be run by RunWen again until 
  118.      August 15, 1992.  
  119.  
  120.      Please read the comment lines in the RUNWEN.FIL file for further
  121.      information about the RUNWEN.FIL file.
  122.  
  123. |    A WORD ABOUT DISK OPTIMIZERS
  124. |    ============================
  125.  
  126. |    Disk optimizers or defragmenters (such as Symantecs Norton Speed Disk)
  127. |    have a unique requirement.  There is only one way you can schedule a
  128. |    disk optimizer program with RunWen.  The optimizer program must provide
  129. |    an "unmovable files" entry in its configuration and you must specify the
  130. |    RUNWEN.FIL file as an unmovable file in the optimizer program.  This
  131. |    requirement exists because while RunWen is processing the RUNWEN.FIL
  132. |    file, the RUNWEN.FIL file is open for read and update.  If a disk
  133. |    optimizer is started by RunWen, and the RUNWEN.FIL file is NOT specified
  134. |    as "unmovable", the optimization process may (read probabally) move part
  135. |    or all or the open RUNWEN.FIL file, corrupting it as it moves it to
  136. |    another location on the disk.
  137.  
  138. |    I could have corrected this problem by reading the entire RUNWEN.FIL
  139. |    (including all comment lines) into memory before processing begins,
  140. |    but then RunWen's memory usage would have increased dramatically.
  141. |    RunWen needs to leave as much base memory available as possible in order
  142. |    to be able to start any program you want to run upon boot-up.
  143.  
  144.      OPTIONS
  145.      =======
  146.  
  147.      The command line for RunWen is as follows:
  148.  
  149. |    C> RUNWEN [-BOOT [-NOPROMPT]] | [-EDIT] | [-LIST] | [-VER] | [-HELP]
  150.  
  151.      The options available on the RunWen command-line are as follows:
  152.  
  153.      -BOOT (abbreviated to -B) is used to tell RunWen to process the 
  154. |         RUNWEN.FIL file.  If a program is scheduled to be run on the
  155. |         current date, RunWen will prompt you to "Run the Scheduled
  156. |         Program? <Y/N/R>".  Enter Y to run the program and reset the
  157. |         last-run date, "N" to not run the program, or "R" to reset the
  158. |         last-run date but not run the program.
  159.  
  160.      -NOPROMPT (abbreviated to -NOP) is used in conjunction with -BOOT
  161.           to tell RunWen not to prompt you whether you want to run 
  162.           the program which is due to be run by RunWen.
  163.  
  164. |    -EDIT (abbreviated to -E) is used to edit the RUNWEN.FIL file.  This
  165. |         option needs the EDITOR environment variable to be set to the 
  166. |         name of your favorite editor (i.e. "set EDITOR=NE.COM" if you use
  167. |         Symantecs Norton Editor).  Additionally, your editor needs to
  168. |         accept the file name to be edited as the first argument on its
  169. |         command-line execution (i.e. you must be able to call the editor
  170. |         with the file name to be edited as the first argument).
  171.  
  172.                                                                    Page 4
  173.  
  174.      -LIST (abbreviated to -L) is used to list the RUNWEN.FIL on the 
  175.           screen.  This option cannot be used in conjunction with the 
  176.           -BOOT [-NOPROMPT] options and is mutually exclusive of the
  177.           -VER and -HELP options.
  178.  
  179.      -VER (abberviated to -V) displays the version of RunWen you are
  180.           using on the screen.  This option cannot be used in conjunction
  181.           with the -BOOT [-NOPROMPT] options and is mutually exclusive of 
  182.           the -LIST and -HELP options.
  183.  
  184.      -HELP (abbreviated to -H or -?) displays a two-page help screen on
  185.           the use of RunWen.  This option cannot be used in conjunction 
  186.           with the -BOOT [-NOPROMPT] options and is mutually exclusive 
  187.           of the -VER and -LIST options.
  188.  
  189.      REGISTRATION
  190.      ============
  191.  
  192.      Registering your copy of RunWen is simple.  Just print out the 
  193.      ORDERFRM.DOC file, fill in the required information, and send it with
  194.      the requested payment amount.  Your registration will be processed per
  195.      your request and you will be placed on my mailing list for any future
  196.      upgrades.
  197.  
  198.      LICENSE
  199.      =======
  200.  
  201.      You are free to use, copy, and distribute the Shareware version of
  202.      RunWen so long as:
  203.  
  204.      1)  No fee is charged for its use.
  205.  
  206.      2)  If a fee is charged, it must be only to cover the cost of copying
  207.          or distribution.
  208.  
  209.      3)  It must be distributed in its original form with all of the 
  210.          originally released files intact.
  211.  
  212.      4)  It has not been modified in ANY way EXCEPT for compression.
  213.  
  214.      No part of the REGISTERED version of RunWen may be reproduced or
  215.      transmitted in any form or by any means, electronic or otherwise,
  216.      for any purpose other than the purchasers personal use, witout
  217.      the express written permission of the author.
  218.  
  219.  
  220.      WARRANTY
  221.      ========
  222.  
  223.      All warranties are disclaimed, including any damage to hardware and/or
  224.      software, from the use of this product.  In no event will I be held 
  225.      liable to you for any damage including lost profits, lost savings or
  226.      other incidental or consequential damages arising out or your use or
  227.      inability to use this program, or any other claim by any other party.
  228.